Update Organisational Unit

Submit the most up-to-date Organisational Unit information. Any field that is present will overwrite existing values within the system, while absent fields will be left as-is.

Update Organisational Unit

cURL

curl --request PATCH \
  --url https://{tenant_name}.{region}.techwolf.ai/organisational_units/{external_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Engineering",
  "active": true,
  "parent_id": "b4824606-fc95-53ed-b80g-6f8c2ge908c8"
}
'

400

[
  {
    "title": "400 Bad Request",
    "description": "The request body was not structured correctly."
  }
]

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

external_id · string<uuid> · required

The unique ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

Body

application/json

Default structure for Organisational Unit data.

name · string

Name of the Organisational Unit.

Required string length: 1 - 255

Example:

"Engineering"

active · boolean · default: true

Indicates whether the Organisational Unit is active or not.

parent_id · string<uuid>

Unique identifier for the parent Organisational Unit, establishing the organisational structure. If updated with parent_id=null, the Organisational Unit becomes a root Organisational Unit.

Required string length: 1 - 100

Pattern: [a-zA-Z0-9_-]+

Example:

"b4824606-fc95-53ed-b80g-6f8c2ge908c8"

Response

204

No Content